home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / doom / elim14pk.zip / README.TXT < prev    next >
Text File  |  1996-09-19  |  11KB  |  335 lines
  1. Eliminator Bot for id Software's Quake
  2. --------------------------------------
  3.  
  4. Archive Version 1.4  (Public Release)
  5. CBOT-Engine Version 1.4
  6.  
  7. Copyright 1996, Cameron B. Newham.
  8.  
  9.  
  10. 0) What this is About
  11. 1) What's New in this Version
  12. 2) Unpacking the Archive
  13. 3) Installing the Patch
  14. 4) Using the Patch
  15. 5) Bugs
  16. 6) Legal
  17. 7) Credits
  18.  
  19.  
  20.  
  21. 0. What this is About
  22. ---------------------
  23.  
  24. The Eliminator Bot package provides you with some decent adversaries
  25. to play Quake against.  Don't have a network connection?  Maybe you
  26. have a $100,000 LAN at home but no friends... Well, here is the
  27. answer to your Deathmatch dreams.  These automated deathmatch opponents
  28. are by no means friendly and they'd just love to kick your sorry
  29. behind all over the place.  What's more, they aren't stupid like
  30. most of the other bots out there.  These know how to fight and know
  31. their way around.
  32.  
  33. Please note that this is a Deathmatch patch. The Bots are designed
  34. specifically for playing against other deathmatch players - not
  35. monsters.  These Bots are *not* "helper" bots.  Indeed, the only help
  36. you'll get from them is a a rocket in your face.
  37.  
  38. For updates, see the CBOT homepage:
  39.  
  40. http://www.iinet.com.au/~cam/quakec.html
  41.  
  42.  
  43. Features include:
  44.  
  45.   * Bots have knowledge of Quake levels (currently only "start" and 
  46.     "e1m5" (Gloom Keep)).
  47.   * Bots are able to pick up all items (health, armour, weapons, 
  48.     ammo, specials).
  49.   * Bots start off with a shotgun and aquire equipment just like a 
  50.     player.
  51.   * Bots know how to swim and can navigate over "broken ground".
  52.   * Bots don't just blindly fire - bots will only attack if they are
  53.     in a position to do so or want to.
  54.   * Bots are able to camp (if they want to).
  55.   * Bots are able to activate all of the triggers on a level (eg:
  56.     buttons, doors, etc).
  57.   * A maximum of 10 bots can be created - each with its own name.
  58.   * You can specify the number of bots to start with in a config file.
  59.   * Bots regenerate at a new Deathmatch location after being killed.
  60.   * Based on the Player model.
  61.   * An Observer Mode is included - watch the bots fight it out
  62.     without getting in the way!
  63.   * Display the bot and player gib scores.
  64.   * Runs on the Quake server allowing it to be used in network games.
  65.   * Ability to use the engine for your own maps - see the Waypoint
  66.     Guide.
  67.   * Bots can use a "skins" MDL to give them visual identities.
  68.  
  69.  
  70.  
  71. 1. What's New in this Version
  72. -----------------------------
  73.  
  74. Version 1.3 -> 1.4
  75.  
  76. * Fixed some bugs
  77. * Added support for low gravity and proper handling of specials
  78. * Added support for server lock (see below)
  79. * Added circle straf and missile avoidance
  80. * Added possible suicide shootout on very low health
  81.  
  82. Version 1.2 -> 1.3
  83.  
  84. * Hopefully fixed the bug that sometimes causes a "cl > cl.maxclients" problem
  85.  
  86. Version 1.1 -> 1.2
  87.  
  88. * Changed to using the player model
  89. * Added skins capability (one line change! :)
  90. * Increased the running speed of the cbots
  91. * Added players (clients) to the Gib Score printout
  92. * Gib Score printout is now local (not broadcast to everyone)
  93. * Added better weapons handling AI - cbots now know not to use
  94.   R/L or G/L up close (unless they have very good health), and
  95.   limits use of the G/L over large distances. SNG and LG are
  96.   only used for short/medium range
  97. * Tweaked some parameters
  98. * Fixed a bug in id's code w.r.t attenuated death sounds (cbots ONLY -
  99.   I didn't fix this for players... perhaps I should have)
  100. * Removed an old id debug use for "temp1"
  101.  
  102. Version 1.0 -> 1.1
  103.  
  104. * Observer Mode is fixed; Observers are now invisible to other players
  105. * cbots now fight even when they are stuck
  106. * cbots are much more willing to initiate an engagement if they only
  107.   have a shotgun
  108. * START and E1M5 have some small changes/fixes
  109. * Added a startup definition for the number of cbots to generate
  110.   on starting a level (useful for servers)
  111. * fixed priority waypoint detection so it's limited by pitch
  112. * fixed MODE determination for engage and disengage attack
  113. * tweaked targetting
  114. * tweaked a few other parameters
  115. * cleaned up some of the code
  116.  
  117.  
  118.  
  119. 2. Unpacking the Archive
  120. ------------------------
  121.  
  122. This archive should include the following files:
  123.  
  124. README.TXT        - This file
  125. PROGS.DAT         - The compiled Quake C code
  126. START.MAP         - The entities for the start level
  127. E1M5.MAP          - The entities for Gloom Keep (e1m5)
  128. ELIM14.TXT        - Template for FTP sites
  129.  
  130. Create a directory (eg: "ELIM") in your Quake directory. Also create
  131. a MAPS directory under this.  Unzip the archive in ELIM. Move the
  132. .MAP files to the MAPS directory.
  133.  
  134.  
  135.  
  136. 3. Installing the Patch
  137. -----------------------
  138.  
  139. You'll need a number things to install this patch:
  140.  
  141.   * An "unpacker" to extract the levels from the Quake PAK file
  142.     I suggest something like "winpack".  Check out a Quake FTP
  143.     site (eg: ftp.cdrom.com) for one.
  144.  
  145.   * QBSP or a derivative (eg: Power QBSP).  Check out a Quake
  146.     FTP site for a version for your system.  There are also
  147.     entity replacers available - you can also use these.
  148.  
  149. Unpack the levels from the PAK0.PAK file (in QUAKE\ID1). You only
  150. need to extract START.BSP and E1M5.BSP.  Place these two files
  151. in the your ELIM\MAPS directory.
  152.  
  153. Now, replace the entities (using QBSP or another entity replacement
  154. program) with the ones defined in this archives MAP files.  For
  155. example, using QBSP and in the ELIM\MAPS directory, you'd type:
  156.  
  157.   qbsp -onlyents start.map
  158.  
  159. and
  160.  
  161.   qbsp -onlyents e1m5.map
  162.  
  163. Make sure you *type -onlyents*. This will replace *only* the entities
  164. and won't attempt to compile the BSP from the MAP file. If you forget,
  165. you'll probably get an error - the MAP files only contain the entity
  166. information and not the brush details.  If this has gone over your head,
  167. don't worry - just follow the above instructions!
  168.  
  169. Also note that you don't have to use VIS or LIGHT on the files.
  170.  
  171. The MAP changes will now have been applied to the BSP files.  All you
  172. have to do now is...
  173.  
  174. Run Quake.  Use the following command line to run it:
  175.  
  176.   quake -listen -game elim
  177.  
  178. This places Quake in Listen mode (Deathmatch) and tells Quake to
  179. use the new PROGS.DAT and the new maps in your ELIM directory tree.
  180.  
  181. If you wish to use skins, you'll need a skins PLAYER.MDL file - a number
  182. of these are available, one of them being in the Skins Patch.  Place the
  183. PLAYER.MDL file in your QUAKE\ELIM\PROGS directory.
  184.  
  185. If you don't use skins this patch will still work but the cbots will
  186. all look the same.
  187.  
  188.  
  189.  
  190. 4. Using the Patch
  191. ------------------
  192.  
  193. Having started Quake you'll be at the START level - if you want to
  194. try Gloom Keep, pull down the Quake Console and type:
  195.  
  196.   map e1m5
  197.  
  198. On either level you can create a cbot by typing
  199.  
  200.   impulse 166
  201.  
  202. at the Quake Console.  I suggest you bind this to a key. From the Quake
  203. Console, type:
  204.  
  205.   bind b "impulse 166"
  206.  
  207. and then every time you hit the "b" key you'll get a cbot.
  208.  
  209. The following commands are available:
  210.  
  211.   impulse 166   - create a cbot (up to a maximum of 10).
  212.   impulse 170   - view the gib scores for the cbots.
  213.   impulse 180   - go to observer mode
  214.  
  215. Gib Scores include cbots and all humans (clients). An asterix (*)
  216. is printed next to your own name.  If you are in Observer Mode you
  217. won't appear on the list.
  218.  
  219. Observer Mode - when you enter this mode you won't be able to exit
  220. it unless you change levels or specifically kill yourself using
  221. the "kill" command at the console.  This is to stop people from
  222. using this mode to their advantage in a human deathmatch.
  223.  
  224. In Observer Mode you can move around the map without affecting
  225. it or other players.  Make sure you remain *inside* rooms to
  226. be able to view other players.
  227.  
  228. It is possible to define a number of cbots to generate automagically.
  229. If you set the Console Variable "temp1" to a number between 1 and 10
  230. in a Quake Config file (see the Quake TECHINFO.TXT file for details)
  231. this patch will generate that number of cbots when you start Quake.
  232. Eg:  if you had the line
  233.  
  234. temp1 6
  235.  
  236. in a config file called CBOT.CFG in your QUAKE\ID1 directory, you'd
  237. get 6 cbots generated on starting Quake with
  238.  
  239. quake -listen +exec cbot.cfg -game elim
  240.  
  241.  
  242. If you add 10 to this number you can lock the number of cbots.
  243. Players within the game will not be able to add more. So if
  244. temp1 set to 15 will give you 5 cbots locked in place.  Players
  245. trying "impulse 166" will get a message telling them its locked.
  246.  
  247.  
  248. 5. Bugs
  249. -------
  250.  
  251. The following Bugs are known:
  252.  
  253.   * cbots occasionally get stuck (this is now a rare event)
  254.   * cbots placed on levels other than those provided will *not* work.
  255.     I haven't stopped creation for non-supported maps because I
  256.     don't believe in restrictions.  With some examination, you should
  257.     be able to work out how to make the cbots work on other levels
  258.     (including your own!).  Note that the *source* code of the
  259.     CBOT Engine isn't necessary for doing this.  BTW, making them
  260.     work for other levels is a coding exercise - best left to those
  261.     with a good grasp of level building and, perhaps, some Quake C
  262.     experience.  See the Waypoint Guide for help.
  263.   * Teams are not supported and would be hard to implement
  264.     effectively.
  265.   * When a cbot dies, the body may appear to move as it hits the 
  266.     ground.
  267.   * Sometimes cbots don't *appear* to lock on to a target completely
  268.     and missiles may miss the intended target.
  269.   * cbots cannot be removed once placed in a level except by changing
  270.     levels.
  271.   * cbots can probably change levels - but I have never seen it happen
  272.     yet.
  273.   * Setting temp1 to more cbots than there are DM entry points may result
  274.     in Quake crashing complaining about out of Edicts. This is because
  275.     the cbots will go into endless telefrags.
  276.  
  277.  
  278.  
  279. 6. Legal
  280. --------
  281.  
  282. Quake is a Tradmark of id Software.
  283.  
  284. All parts of this software not coded by myself are Copyright
  285. id Software.
  286.  
  287. The CBOT Engine and associated MAP file components are Copyright 1996,
  288. Cameron Newham.
  289.  
  290. This software is provided "as is".  There is no warrenty either
  291. expressed or implied.  USE AT YOUR OWN RISK.  The author cannot be
  292. held responsible for any loss or damages incurred from use of
  293. this software.
  294.  
  295. You are permitted to copy and redistribute this archive AS LONG
  296. AS THIS TEXT FILE and the other files in the archive REMAIN INTACT 
  297. AND UN-ALTERED.
  298.  
  299. You are NOT permitted to use or modify any of the Engine source code
  300. without express permission from the author.
  301.  
  302. You are permitted to use the CBOT Engine with other MAP file
  303. information that you create or on any public or private Quake
  304. server.
  305.  
  306.  
  307.  
  308. 7. Credits
  309. ----------
  310.  
  311. Thanks to id Software for such an excellent game.
  312.  
  313. The following people kindly helped me Beta Test the patch:
  314.  
  315. Roger Bolton
  316. Rowan Crawford ("Sumaleth" on IRC)
  317. Ben Schaffer
  318.  
  319. Thanks also to
  320.  
  321. Thane Sherrington - idea of auto-generation of cbots on startup
  322. Rene Post - the first to suggest using skins and asking for the
  323.             player scores to be added to the Gib printout.
  324.  
  325. Also thanks to a few people who suggested straffing/shooting
  326. and missile avoidance.
  327.  
  328. Thanks to everyone for helpful comments and suggestions and bug reports!
  329.  
  330.  
  331. I hope that you enjoy this patch!
  332.  
  333. cameron newham (cam@iinet.com.au)
  334.  
  335.